JxBrowser/com.teamdev.jxbrowser.engine/[jvm]EngineOptions/Builder

Builder

public final class Builder

A builder class to construct engine options.

Builders are created by invoking newBuilder. Each of the setter methods modifies the state of the builder and returns the same instance. Builders are not thread-safe and should not be used concurrently from multiple threads without external synchronization.

Functions

public EngineOptions.Builder addScheme(Scheme scheme, InterceptUrlRequestCallback callback)

Associates the given URL scheme with the callback, so that all URL requests with the given scheme will be intercepted before they are sent out.

public EngineOptions.Builder addSwitch(String commandLineSwitch)

Adds the switch to the list of the switches that will be passed to the Chromium process.

allowFileAccessFromFiles

public EngineOptions.Builder allowFileAccessFromFiles()

Allows file access from files for the Engine instance.

public EngineOptions build()

Creates an EngineOptions instance.

public EngineOptions.Builder chromiumDir(Path chromiumDir)

Sets the absolute path to the directory where Chromium binaries are located.

disableDnsOverHttps

public EngineOptions.Builder disableDnsOverHttps()

Indicates whether the DNS over HTTPS (DoH) protocol is disabled.

disableDnsQuickCheck

public EngineOptions.Builder disableDnsQuickCheck()

Disables DNS quick check.

public EngineOptions.Builder disableGpu()

Disables GPU rendering for the Engine instance.

public EngineOptions.Builder disableSandbox()

Disables the sandbox for the Engine instance.

disableTouchMenu

public EngineOptions.Builder disableTouchMenu()

Disables the touch popup menu for the Engine instance.

disableWebSecurity

public EngineOptions.Builder disableWebSecurity()

Disables the same-origin policy for the Engine instance.

public EngineOptions.Builder diskCacheSize(long diskCacheSize)

Sets the disk cache size, in bytes.

public EngineOptions.Builder enableAutoplay()

Allows automatically starting video and audio playbacks.

enableIncognito

public EngineOptions.Builder enableIncognito()

Enables the incognito mode for the default profile of the Engine instance.

enableMediaRouting

public EngineOptions.Builder enableMediaRouting()

Enables media routing for the Engine instance.

enableProprietaryFeature

public EngineOptions.Builder enableProprietaryFeature(ProprietaryFeature feature)

Enables the given proprietary feature for the Engine instance.

public EngineOptions.Builder googleApiKey(String googleApiKey)

Sets the Google API key.

googleDefaultClientId

public EngineOptions.Builder googleDefaultClientId(String googleDefaultClientId)

Sets the Google client ID.

googleDefaultClientSecret

public EngineOptions.Builder googleDefaultClientSecret(String googleDefaultClientSecret)

Sets the Google client secret.

public EngineOptions.Builder language(Language language)

Sets the Chromium language that is used on the default error pages and the message dialogs.

public EngineOptions.Builder licenseKey(String licenseKey)

Sets the licence key required to perform operations with the engine.

public EngineOptions.Builder passwordStore(PasswordStore passwordStore)

Sets the password store type that specifies which storage backend to use to encrypt cookies on Linux.

remoteDebuggingPort

public EngineOptions.Builder remoteDebuggingPort(int remoteDebuggingPort)

Sets the remote debugging port.

rendererHangTimeout

public EngineOptions.Builder rendererHangTimeout(Duration timeout)

Sets how long the renderer can be unresponsive before it is considered hung.

treatInsecureOriginAsSecure

public EngineOptions.Builder treatInsecureOriginAsSecure(Array<String> origins)

Adds the given origins to the white list.

public EngineOptions.Builder userAgent(String userAgent)

Sets the custom user agent string that is used to override the default user agent for the Engine.

public EngineOptions.Builder userDataDir(Path userDataDir)

Sets the absolute path to the directory where the user data is stored.